home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / sfwcdr.zip / SFWCDR.DOC next >
Text File  |  1990-12-09  |  12KB  |  259 lines
  1.                                   SFWCDR
  2.                   Wildcat Door To SPITFIRE Conversion Program     
  3.                                Version 1.1
  4.                     Copyright (C) By Mike Woltz, 1989, 1990
  5.                              Buffalo Creek Software
  6.                                   A Member Of 
  7.                    The Association Of Shareware Professionals
  8.  
  9.  
  10.     INTRODUCTION
  11.     ------------  
  12.      
  13.        SFWCDR is a utility written by Mike Woltz, author of SPITFIRE, to
  14.     enable Wildcat door programs to be used with SPITFIRE.  Using SFWCDR
  15.     you may setup the Wildcat door program to be used either as a SPITFIRE
  16.     door or as a sysop configurable command from the SPITFIRE Main, Message
  17.     or File menus.
  18.    
  19.    
  20.     COMMAND LINE PARAMETERS
  21.     -----------------------
  22.  
  23.        SFWCDR uses two command line parameters during its operation.
  24.        
  25.        /P  -  Must be used to determine the drive and directory where
  26.               the Wildcat door program files exist and the placement
  27.               of the CALLINFO.BBS.
  28.  
  29.       /WC1 -  Should be used to designate the Wildcat door being run
  30.               was written for Wildcat Version 1.? and a CALLINFO.BBS
  31.               is written using Wildcat V1.? format.  If the /WC1
  32.               command line parameter is not used, SFWCDR defaults
  33.               to Wildcat Version 2.? and the CALLINFO.BBS is written
  34.               using Wildcat V2.? format.
  35.            
  36.        For instance, let's assume you wanted to run a Wildcat door 
  37.     program that was written for Wildcat Version 1.?.  Also assume,
  38.     SPITFIRE is being run from the SF directory of drive C and a DOOR_A 
  39.     directory was created from the SF directory for running the Wildcat
  40.     door.  With these assumptions, your command line would look like this:
  41.     
  42.     SFWCDR /P C:\SF\DOOR_A /WC1
  43.     
  44.     Under the same circumstances, if you were running a door written for
  45.     Wildcat Version 2.?, your command line would look like this:
  46.     
  47.     SFWCDR /P C:\SF\DOOR_A
  48.  
  49.     It should be noted that if no /P command line parameter is set, SFWCDR
  50.     will not run.
  51.  
  52.  
  53.     HOW IT WORKS 
  54.     ------------
  55.     
  56.        SFWCDR.EXE must exist in the main SPITFIRE system files directory.
  57.     This is absolutely necessary for SFWCDR to access other files which
  58.     are required for the proper execution of SFWCDR.
  59.        
  60.        When SFWCDR is executed it first will check for the SFDOORS.DAT file.
  61.     If this is found, this signifies that the Wildcat door program has been
  62.     set up to run as a SPITFIRE door.  If this is not found, it continues
  63.     to look for SFMAIN.DAT, SFMESS.DAT or SFFILE.DAT, in the order listed.  
  64.     If one of these files are found it signifies the Wildcat door program 
  65.     is being run as a sysop configurable command from the corresponding menu.  
  66.     This allows SFWCDR to determine which batch file will be used to run the
  67.     Wildcat door program.  If none of the above mentioned DAT files are
  68.     found SFWCDR will not run.
  69.     
  70.        SFWCDR will then read and obtain information from the SFNODE.DAT,
  71.     SFSYSTEM.DAT, SFDOORS.DAT, SFUSERS.DAT, and DAILYLMT.DAT.  The 
  72.     information obtained from these files is used to create CALLINFO.BBS.  
  73.     CALLINFO.BBS is a data file used with Wildcat door programs.  
  74.     CALLINFO.BBS is then written to the directory you specified earlier 
  75.     with the /P command line parameter.  The format of the CALLINFO.BBS
  76.     data file will be dependent upon whether you have used the /WC1
  77.     command line parameter.  As mentioned earlier, if the /WC1 command
  78.     line parameter is used the CALLINFO.BBS is written in the format
  79.     of that used by Wildcat Version 1.?.  If the /WC1 is omitted,
  80.     the CALLINFO.BBS is written in the format of that used by Wildcat
  81.     Version 2.?.
  82.     
  83.        It should also be mentioned that if SFWCDR fails to run because
  84.     the /P command line parameter has not been specified or due to the
  85.     inability to locate the necessary DAT file, SFWCDR will send an 
  86.     ERRORLEVEL 1 to DOS.  If DAILYLMT.DAT is not found, SFWCDR will
  87.     default to 20 downloads per day and 1000K downloadable bytes per day.
  88.        
  89.     
  90.     USING SFWCDR TO RUN A SPITFIRE DOOR
  91.     -----------------------------------
  92.        
  93.        The first thing you will need to be concerned with when using
  94.     SFWCDR to run a SPITFIRE door will be to create or modify an existing
  95.     SFDOOR.MNU.  Using your favorite text editor you will need to
  96.     include a line that contains a brief description of the door program
  97.     you intend to run, a comma, and the security level required by the
  98.     user to access this SPITFIRE door.  (The line number should correspond 
  99.     to the door number you are running your door program in.  For this 
  100.     example we will be using Door number 1.  For more detailed information 
  101.     refer to the SPITFIRE manual.)  A typical line of your SFDOOR.MNU might
  102.     look like this:
  103.     
  104.     The Door Description,10
  105.     
  106.     If you are using SFDR[x].BBS/CLR sysop created non-ansi and ansi
  107.     menus these will need to be modified also.
  108.     
  109.        Next you will also need to modify your SF.BAT file with your 
  110.     favorite text editor.  Locate the line which contains :DOOR_A.
  111.     You will need to place your door A commands (valid DOS commands,
  112.     program execution, etc.) between :DOOR_A and GOTO LOOP.  A typical
  113.     example of this portion of your SF.BAT might be changed to read as
  114.     listed below:
  115.     
  116.          :DOOR_A
  117.          SFWCDR /P C:\SF\DOOR_A
  118.          IF ERRORLEVEL 1 GOTO LOOP
  119.          CD\SF\DOOR_A
  120.          PROGRAM NAME  
  121.          DEL CALLINFO.BBS
  122.          CD\SF
  123.          GOTO LOOP
  124.          
  125.     If the Wildcat door program you are using requires the use of a
  126.     configuration file, the name of the configuration file would be
  127.     added on the same line as, and after the PROGRAM NAME.  For instance,
  128.     instead of PROGRAM NAME you would need PROGRAM NAME and a blank
  129.     space followed by the name of the configuration file.  Or if the door
  130.     was written for Wildcat Version 1.?, you would need to add the
  131.     /WC1 command line parameter.
  132.     
  133.      
  134.     
  135.     USING SFWCDR FROM A SPITFIRE MENU
  136.     ---------------------------------
  137.     
  138.        SPITFIRE has a sysop configurable command for the Main, Message 
  139.     and File menus.  The sysop configurable command is executed through 
  140.     a batch file which corresponds to the menu it is being run from.  In
  141.     other words, SFMAIN.BAT runs the sysop configurable command from the
  142.     Main Menu, SFMESS.BAT runs the one from the Message Menu and SFFILE.BAT 
  143.     the one from the File Menu.  The commands necessary to execute SFWCDR 
  144.     and run the Wildcat door program are set up in the batch file which 
  145.     corresponds to the menu you wish to have program run from.
  146.  
  147.        The first thing you will need to establish is which of these menus
  148.     you wish to use to run the Wildcat door program.  For this purpose, 
  149.     let's assume that it is going to be set up so it can be run from the 
  150.     Main Menu.  (It should be noted the set up procedure will be the same 
  151.     regardless of which Menu you are running SFWCDR and the Wildcat door
  152.     program from.)
  153.  
  154.        Next, you will need to decide what you wish to name the command
  155.     option and establish what security level will be required for
  156.     users of your system to be able to access this option.  Once this
  157.     is determined you will need to modify the SFMAIN.MNU file using
  158.     your favorite text editor, as long as it saves in ASCII format.
  159.     (Refer to the SPITFIRE manual for further documentation on this
  160.     if needed.  It should also be noted that if SFWCDR were being
  161.     set up to run from the File Menu, you would need to modify the
  162.     SFFILE.MNU file and if it was being set up to be run from the
  163.     Message Menu you would need to modify the SFMSG.MNU file.)
  164.  
  165.        Examining the default SFMAIN.MNU file, you will notice the sysop
  166.     configurable command appears as:
  167.  
  168.        <K>............. Add Your Own,,1000,@
  169.  
  170.        This will need to be replaced with a Command Character that will
  171.     be used to select the option from the menu.  It is ABSOLUTELY IMPERATIVE
  172.     that the Command Character must not duplicate an existing Command
  173.     Character for another menu option.  You will then need to include
  174.     a brief description of the Wildcat door program you are running, two
  175.     commas, the security level required to access this feature, and another
  176.     comma followed by the a @.  The @ must not be changed! (For more detailed
  177.     information on modifying your SFMAIN.MNU, SFMSG.MNU or SFFILE.MNU refer
  178.     to your SPITFIRE manual.)
  179.     
  180.        <K>.... Brief Program Description,,10,@
  181.  
  182.        Now you will need to modify the corresponding batch file, SFMAIN.BAT,
  183.     so that it can be executed from the Main Menu.  Do this using your
  184.     favorite text editor, as long as it saves in ASCII format.  (Again, it
  185.     should be noted that if SFWCDR and the Wildcat door program were being 
  186.     set up to run from the File Menu, you would need to modify the SFFILE.BAT 
  187.     file and if it was being set up to be run from the Message Menu you would 
  188.     need to modify the SFMESS.BAT file.)
  189.  
  190.        The commands you will need to include in your SFMAIN.BAT to run 
  191.     SFWCDR and the Wildcat door program might look similar to this:
  192.    
  193.        ECHO OFF
  194.        BRK OFF
  195.        SFWCDR /P C:\SF\DIRNAME
  196.        IF ERRORLEVEL 1 GOTO END
  197.        CD\SF\DIRNAME
  198.        PROGRAM NAME
  199.        :END
  200.        CD\SF
  201.        BRK ON
  202.  
  203.        (BRK is written and copyrighted by Solid Systems, 1985, but can 
  204.     be downloaded from Buffalo Creek's BBS as well as a number of other 
  205.     BBS systems.  BRK is not required, however, it is recommended since it
  206.     will prevent a caller using the CTRL BRK command to terminate the batch 
  207.     file, gaining access to your system at the DOS level.)
  208.  
  209.       In the above example, C:\SF\DIRNAME refers to the drive and the 
  210.     directory in which the Wildcat door program files reside.  The actual
  211.     Wildcat door program name would be entered where PROGRAM NAME is 
  212.     currently.   If the Wildcat door program you are using requires the 
  213.     use of a configuration file, the name of the configuration file would 
  214.     be added on the same line as and after the program.  For instance,
  215.     instead of PROGRAM NAME you would need PROGRAM NAME and a blank
  216.     space followed by the name of the configuration file.  If the door
  217.     was written for Wildcat Version 1.?, you would need to add the
  218.     /WC1 command line parameter.
  219.  
  220.    
  221.     SFWCDR ON A MULTI-NODE SYSTEM
  222.     -----------------------------
  223.    
  224.        SFWCDR is fully compatible for operation on a multi-node BBS.
  225.     It automatically handles any file locking and file sharing 
  226.     required during program execution.   However, the WWIV door being
  227.     used with SFWCDR may not have this capability.  Please refer
  228.     to the Wildcat door's documentation in regard to it's multi-node
  229.     capability.
  230.     
  231.     
  232.     DISTRIBUTION
  233.     ------------
  234.  
  235.        SFWCDR is distributed under the shareware concept.  You are
  236.     free to distribute the SFWCDR program as long as it remains
  237.     unmodified and no fee is charged.  If you use this program and
  238.     find it beneficial a fee is required.  A $1.00 fee is required
  239.     of registered SPITFIRE Sysops and a $5.00 fee is required of
  240.     all others.  
  241.     
  242.     
  243.     DISCLAIMER
  244.     ----------
  245.         
  246.          Mike Woltz and/or Buffalo Creek Software shall in no way be held 
  247.      responsible for any damage incurred while operating SFWCDR.  All 
  248.      responsibility lies with the user of the software.
  249.  
  250.  
  251.        The documentation for SFWCDR is contributed by Jacque Shipley
  252.     and The Mother Board BBS.  The shareware version of SPITFIRE 
  253.     and other SPITFIRE utilities are available for download from:
  254.  
  255.          Buffalo Creek's BBS              The Mother Board BBS
  256.           Mike Woltz, Sysop               Jacque Shipley, Sysop
  257.            (515) 225-8496                    (515) 986-3464
  258.    38400/19200/9600/2400/1200 Baud      19200/9600/2400/1200 Baud
  259.